Manage the categories of voucher entities.
| Name | Type | Is Mandatory |
|---|---|---|
| HierarchyNode | String | |
| ParentHierarchyNode | String | |
| HierarchyLevel | Int16 | |
| VoucherCategoryId | Int16 | |
| Label | String | |
| Identifier | String | |
| SourceId | Int16 | |
| DeletionFlag | Boolean | |
| VoucherCategoryPath | String | |
| VoucherTypeId | Int16 | |
| Amount | Decimal | |
| PointCost | Int32 | |
| LoyaltyCardTypeId | Int16 | |
| VoucherExpirationDelayDay | Int32 | |
| VoucherExpirationDelayMonth | Int32 | |
| VoucherExpirationDelayYear | Int32 | |
| Source | Source | |
| Vouchers | Collection of Voucher | |
| VoucherCategoryTranslations | Collection of VoucherCategoryTranslation | |
| VoucherType | VoucherType | |
| LoyaltyCardType | LoyaltyCardType |
Select all VoucherCategories
https://customerapi.fts-crm360.com/data/VoucherCategories()
HttpMethod : GET
Json Result :
[
{
"HierarchyNode" : "gR7F7itY",
"ParentHierarchyNode" : "ssevUa47",
"HierarchyLevel" : "3",
"VoucherCategoryId" : "3",
"Label" : "UCgspxrBKYbnX",
"Identifier" : "MtLS8b",
"SourceId" : "1",
"DeletionFlag" : "False",
"VoucherCategoryPath" : "vOxjsNq8Hf",
"VoucherTypeId" : "6",
"Amount" : "9573428.738",
"PointCost" : "26",
"LoyaltyCardTypeId" : "1",
"VoucherExpirationDelayDay" : "11",
"VoucherExpirationDelayMonth" : "64",
"VoucherExpirationDelayYear" : "13"
},
{
"HierarchyNode" : "tpP0g2qxd2N9 f",
"ParentHierarchyNode" : "HtLu871yk",
"HierarchyLevel" : "4",
"VoucherCategoryId" : "3",
"Label" : "dKq5kf7T2pIC",
"Identifier" : "9wj830ta77ZbYvxz",
"SourceId" : "5",
"DeletionFlag" : "False",
"VoucherCategoryPath" : "oJSTMSZ",
"VoucherTypeId" : "3",
"Amount" : "5255629.923",
"PointCost" : "84",
"LoyaltyCardTypeId" : "7",
"VoucherExpirationDelayDay" : "52",
"VoucherExpirationDelayMonth" : "51",
"VoucherExpirationDelayYear" : "9"
},
...
]
Select VoucherCategory by Id
https://customerapi.fts-crm360.com/data/VoucherCategories(3)
HttpMethod : GET
Json Result :
{
"HierarchyNode" : "NRdLvKe Z nq",
"ParentHierarchyNode" : "WpegKUed Sb",
"HierarchyLevel" : "7",
"VoucherCategoryId" : "6",
"Label" : "mjmHDvE6 MjX",
"Identifier" : "BDjuTTt6LL VwC",
"SourceId" : "7",
"DeletionFlag" : "False",
"VoucherCategoryPath" : "v k9z Y",
"VoucherTypeId" : "3",
"Amount" : "6944839.875",
"PointCost" : "42",
"LoyaltyCardTypeId" : "3",
"VoucherExpirationDelayDay" : "57",
"VoucherExpirationDelayMonth" : "13",
"VoucherExpirationDelayYear" : "45"
}
Create a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories()
HttpMethod : POST
Json Post :
{
"HierarchyNode" : "kaYmyTsVdobjyoNOKb",
"ParentHierarchyNode" : "YWfV4BhCkULlmhsZ",
"HierarchyLevel" : "4",
"Label" : "wePNB7L0Y D",
"Identifier" : "LEHXDgDE",
"SourceId" : "5",
"DeletionFlag" : "False",
"VoucherCategoryPath" : "PG SC0AF",
"VoucherTypeId" : "3",
"Amount" : "8849523.621",
"PointCost" : "64",
"LoyaltyCardTypeId" : "5",
"VoucherExpirationDelayDay" : "98",
"VoucherExpirationDelayMonth" : "35",
"VoucherExpirationDelayYear" : "15"
}
Informations :
- Non mandatory fields are optional for Json Post
Update a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories(3)
HttpMethod : PUT
Json Post :
{
"HierarchyNode" : "dPdLUS",
"ParentHierarchyNode" : "LP FAoI X4 YYqK14Mf",
"HierarchyLevel" : "9",
"VoucherCategoryId" : "4",
"Label" : "sQw1Mkkh45i0NsgCS5",
"Identifier" : "RnJ7w",
"SourceId" : "4",
"DeletionFlag" : "True",
"VoucherCategoryPath" : "k9zWfPhuVJ",
"VoucherTypeId" : "5",
"Amount" : "6481985.554",
"PointCost" : "84",
"LoyaltyCardTypeId" : "9",
"VoucherExpirationDelayDay" : "59",
"VoucherExpirationDelayMonth" : "93",
"VoucherExpirationDelayYear" : "39"
}
Informations :
- Non mandatory fields are optional for Json Post
Patch a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories(3)
HttpMethod : PATCH
Json Post :
{
"VoucherCategoryPath" : "EFzFxRM85FMU8K",
"Label" : "tHcbnbnPGN9 BuEN",
"VoucherExpirationDelayYear" : "42"
}
Informations :
- Non mandatory fields are optional for Json Post
Delete a VoucherCategory
https://customerapi.fts-crm360.com/data/VoucherCategories(3)
HttpMethod : DELETE
Translate a VoucherCategory label
https://customerapi.fts-crm360.com/data/VoucherCategories(3)/Label
HttpMethod : GET
Required Fields :
Http Header for language : X-Crm360Api-Language-3